Ulm Ux Api icon

Ulm Ux Api

1.0.x
(1 review)

TMF638 listService

/service[GET]

This method is to retrieve service details of customer.

URL
https://{host:port}/ulm-ux/v1/{businessId}/service
URL PARAMS
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Y
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUID, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.N
Query Param
nametypedescriptionrequired
relatedParty.characteristic.namestringCharacteristics of a customer.
Example: documentId		Y
relatedParty.characteristic.valuestringValue of the documentIdY
relatedParty.@typeStringExample: CustomerN
supportingResource.namestringName of supporting service that you need to retrieve
Example: MacAddress		Y
cURL request - list service with MacAddress - CR
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/dev/ulm-ux-lcr/ulm-ux/v1/CR/service?relatedParty.characteristic.name=documentId&relatedParty.@type=Customer&relatedParty.characteristic.value=422445569&supportingResource.name=MacAddress' \
--header 'client_id: xxxxxxxxxxx' \
--header 'client_secret: xxxxxxxx' \
--header 'X-Correlation-ID: {guid}'
Success Response - for CR
[
    {
        "id": "1-5319635583",
        "description": "SAGEMCOM  FAST 3896  CONTADO",
        "relatedParty": [
            {
                "id": "1137158",
                "contactMedium": [
                    {
                        "mediumType": "billingAddress",
                        "characteristic": {
                            "street1": "SAN JOSE",
                            "street2": "SAN JOSE",
                            "city": "CONDOMINIO OASIS DE SAN JOSE TORRE C APART 501",
                            "country": null
                        }
                    }
                ],
                "@baseType": "RelatedPartyRefOrValue",
                "@referredType": "BillingAccount"
            }
        ],
        "supportingResource": [
            {
                "id": "",
                "name": "macAddress",
                "@baseType": "Resource",
                "@type": "LogicalResource"
            }
        ],
        "relatedEntity": [
            {
                "id": "1137158",
                "name": "ACC_010001137158",
                "role": "account",
                "@referredType": "BillingAccount"
            }
        ]
    }
]

Reviews